# Copyright 2015 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==============================================================================
"""Turn Python docstrings into Markdown for TensorFlow documentation."""


import enum
import inspect

from typing import Any


class ObjType(enum.Enum):
  """Enum to standardize object type checks."""
  TYPE_ALIAS = 'type_alias'
  MODULE = 'module'
  CLASS = 'class'
  CALLABLE = 'callable'
  # properties or any `descriptor`
  PROPERTY = 'property'
  OTHER = 'other'

  @classmethod
  def get(cls, py_obj: Any) -> 'ObjType':
    """Get the `ObjType` for the `py_object`."""
    if (getattr(py_obj, '__args__', None) and
        getattr(py_obj, '__origin__', None)):
      return cls.TYPE_ALIAS
    elif inspect.ismodule(py_obj):
      return cls.MODULE
    elif inspect.isclass(py_obj):
      return cls.CLASS
    elif callable(py_obj):
      return cls.CALLABLE
    elif hasattr(py_obj, '__get__'):
      # This handles any descriptor not only properties.
      # https://docs.python.org/3/howto/descriptor.html
      return cls.PROPERTY
    else:
      return cls.OTHER
